<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: EnvironmentParameters Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1EnvironmentParameters.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classUnity_1_1MLAgents_1_1EnvironmentParameters-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">EnvironmentParameters Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A container for the Environment Parameters that may be modified during training.  
 <a href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac8c13b8d2df9eccaa7a8da3a003fa6a7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html#ac8c13b8d2df9eccaa7a8da3a003fa6a7">GetWithDefault</a> (string key, float defaultValue)</td></tr>
<tr class="memdesc:ac8c13b8d2df9eccaa7a8da3a003fa6a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the parameter value for the specified key.  <a href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html#ac8c13b8d2df9eccaa7a8da3a003fa6a7">More...</a><br /></td></tr>
<tr class="separator:ac8c13b8d2df9eccaa7a8da3a003fa6a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a3f7ba54f3144e2cea983a17ea16ed3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html#a9a3f7ba54f3144e2cea983a17ea16ed3">RegisterCallback</a> (string key, Action&lt; float &gt; action)</td></tr>
<tr class="memdesc:a9a3f7ba54f3144e2cea983a17ea16ed3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a callback action for the provided parameter key.  <a href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html#a9a3f7ba54f3144e2cea983a17ea16ed3">More...</a><br /></td></tr>
<tr class="separator:a9a3f7ba54f3144e2cea983a17ea16ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a210172bb3ec64424629d728b7c5fffa1"><td class="memItemLeft" align="right" valign="top">IList&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html#a210172bb3ec64424629d728b7c5fffa1">Keys</a> ()</td></tr>
<tr class="memdesc:a210172bb3ec64424629d728b7c5fffa1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a list of all the parameter keys that have received values.  <a href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html#a210172bb3ec64424629d728b7c5fffa1">More...</a><br /></td></tr>
<tr class="separator:a210172bb3ec64424629d728b7c5fffa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A container for the Environment Parameters that may be modified during training. </p>
<p>The keys for those parameters are defined in the trainer configurations and the the values are generated from the training process in features such as Curriculum Learning and Environment Parameter Randomization.</p>
<p>One current assumption for all the environment parameters is that they are of type float.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac8c13b8d2df9eccaa7a8da3a003fa6a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8c13b8d2df9eccaa7a8da3a003fa6a7">&#9670;&nbsp;</a></span>GetWithDefault()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float GetWithDefault </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>defaultValue</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the parameter value for the specified key. </p>
<p>Returns the default value provided if this parameter key does not have a value. Only returns a parameter value if it is of type float.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>The parameter key</td></tr>
    <tr><td class="paramname">defaultValue</td><td>Default value for this parameter.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>

</div>
</div>
<a id="a210172bb3ec64424629d728b7c5fffa1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a210172bb3ec64424629d728b7c5fffa1">&#9670;&nbsp;</a></span>Keys()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">IList&lt;string&gt; Keys </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a list of all the parameter keys that have received values. </p>
<dl class="section return"><dt>Returns</dt><dd>List of parameter keys.</dd></dl>

</div>
</div>
<a id="a9a3f7ba54f3144e2cea983a17ea16ed3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a3f7ba54f3144e2cea983a17ea16ed3">&#9670;&nbsp;</a></span>RegisterCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void RegisterCallback </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Action&lt; float &gt;&#160;</td>
          <td class="paramname"><em>action</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a callback action for the provided parameter key. </p>
<p>Will overwrite any existing action for that parameter. The callback will be called whenever the parameter receives a value from the training process.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>The parameter key</td></tr>
    <tr><td class="paramname">action</td><td>The callback action</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="EnvironmentParameters_8cs.html">EnvironmentParameters.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1EnvironmentParameters.html">EnvironmentParameters</a></li>
  </ul>
</div>
</body>
</html>
